/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package axil.framework.error;

import axil.etc.NameValue;

import static axil.framework.Functions.*;


/**
 * An internal, non-localized exception. If you see one of these, it is either
 * a bug in Axil or some form of mis-configuration.
 *
 * These exceptions are NOT intended to be displayed to the user. Displaying
 * such an exception to the user may be considered an information exposure
 * vulnerability. Try this if you need an explanation:
 *
 * 		https://www.owasp.org/index.php/Information_Leakage
 */
public class InternalException extends RuntimeException {
	private NameValue[] values;


	public InternalException(String message, NameValue... parts) {
		super(message);
		values = parts;
	}


	public InternalException(Throwable cause, NameValue... parts) {
		super("An unexpected error has occurred. See the contained exception " +
		      "for details.", cause);
		values = parts;
	}


	public InternalException(Throwable cause, String message,
	                         NameValue... parts) {
		super(message, cause);
		values = parts;
	}


	/**
	 * Return a string representation of this object. The string returned is
	 * never null. The string returned may contain newline characters providing
	 * a modest bit of formatting.
	 */
	public String format() {
		StringBuilder b = new StringBuilder(single(wrap(getMessage())));
		for (NameValue v : values) {
			if (b.length() > 0) {
				b.append('\n');
			}
			b.append(v.key());
			b.append(" = ");
			b.append(str(v.value()));
		}
		return b.toString();
	}


	/**
	 * Return a string representation of this object. The string returned is
	 * never null.
	 */
	public String toString() {
		return this.getClass().getName() + ":\n" + format();
	}
}
